<?php

/**
 * Interface declaration for class objects implementing an address parser
 *
 * PHP version 5
 *
 * LICENSE:
 *
 * Copyright (c) 2008-2009, Philippe Jausions / 11abacus
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   - Redistributions of source code must retain the above copyright notice,
 *     this list of conditions and the following disclaimer.
 *   - Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *   - Neither the name of 11abacus nor the names of its contributors may
 *     be used to endorse or promote products derived from this software
 *     without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * @category  Structures
 * @package   Structures_Location
 * @author    Philippe Jausions <Philippe.Jausions@11abacus.com>
 * @copyright 2008-2009 by Philippe Jausions / 11abacus
 * @license   http://www.opensource.net/licenses/bsd-license.php New BSD
 */

/**
 * Interface declaration for class objects implementing an address parser
 * 
 * @category Structures
 * @package  Structures_Location
 * @author   Philippe Jausions <Philippe.Jausions@11abacus.com>
 */
interface Structures_Location_ParserInterface
{
    /**
     * Returns the country 2-letter ISO code the parser is for
     * 
     * @return string Uppercase 2-letter ISO country code
     */
    public function getCountryCode();

    /**
     * Parses a multi-line address to find as much information as possible 
     * about the location
     * 
     * @param string                              $address     Multi-line address to parse
     * @param string|Structures_LocationInterface $classObject Class name or instance to fill information with
     * @param array                               &$remainder  Rest of address not parsed
     *
     * @return Structures_LocationInterface $location instance
     */
    public function parse($address, $classObject = 'Structures_Location',
                          &$remainder = array());

    /**
     * Determines if the mailing address is "poste restante" (aka "General Delivery")
     *
     * @param Structures_Location_PostalAddressInterface|string $address
     *
     * @return boolean TRUE if poste restante, FALSE otherwise or unknown
     */
    public function isPosteRestante($address);

    /**
     * Determines if the mailing address is for a post office box (PO Box)
     *
     * @param Structures_Location_PostalAddressInterface|string $address
     * 
     * @return string|NULL PO Box information or NULL if none is found
     */
    public function getPostOfficeBox($address);
}

?>